<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Extended Item Data Prepare-Time Support</title>
<style>@import url("file:/C:/eclipse/Eclipse 3.2/plugins/org.eclipse.sdk_3.2.0.v20060214/book.css");</style>
<style>@import url("file:/C:/eclipse/Eclipse 3.2/configuration/org.eclipse.osgi/bundles/120/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1><CENTER>Extended Item Data Prepare-Time Support</CENTER></H1>
<p></p>
<h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.birt.report.engine.reportitemQuery<p></p>
<h6 class=CaptionFigColumn id=header>Since: </h6>1.0
<p></p>

<p>
<h6 class=CaptionFigColumn id=header>Description: </h6>This extension point specifies how the data that the new report item needs should be prepared. In a server environment, the plugin registry uses this extension point registration to discover supported report item extensions.</p>
<p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p>
<p class=code id=dtd>&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.reportItem">reportItem</a>)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST extension</p>
<p class=code id=dtdAttlist>point&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<ul class=ConfigMarkup id=attlistDesc>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.reportItem">reportItem</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST reportItem</p>
<p class=code id=dtdAttlist>name&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>class&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>name</b> - name of the extension item, such as "chart" for chart.</li>
<li><b>class</b> - class which implements IReportItemQuery</li>
</ul>
<br><h6 class=CaptionFigColumn id=header>Examples: </h6>The following is a sample usage of the reportItemQUery extension point:

<p>
<pre>
<p class=code id=tag>&lt;extension point=<p class=code id=cstring>&quot;org.eclipse.birt.report.engine.reportitemquery&quot;</p><p class=code id=tag> 
name=<p class=code id=cstring>&quot;chart report query extension&quot;</p><p class=code id=tag>&gt;</p>
  <p class=code id=tag>&lt;reportItem name=<p class=code id=cstring>&quot;org.eclipse.birt.chart&quot;</p><p class=code id=tag> class=<p class=code id=cstring>&quot;org.eclipse.birt.report.chartitem.ChartQuery&quot;</p><p class=code id=tag>/&gt;</p>
 <p class=code id=tag>&lt;/extension&gt;</p>
 </pre>
 <p>
<p></p>

<h6 class=CaptionFigColumn id=header>API Information: </h6>The value of the class attribute must be the fully qualified name of a class that implements <code>org.eclipse.birt.engine.extension.IReportItemQuery</code>. The interface provides the following functions:

<ul>
<li><code>public void setModelObject(ExtendedItemHandle handle)</code> ---- 
 passes the model object to the extension provider. </li>
<li><code>public IBaseQueryDefinition[] getReportQueries(IBaseQueryDefinition parent) throws BirtException;</code> ----
returns report queries that engine uses to prepare data for the extended item.</li>
</ul>
<p>
<p></p>

<h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>Chart as an extended item
<p></p>

<br>
<p class=note id=copyright>
Copyright (c) 2005 Actuate Corporation. All rights reserved. This program and 
the accompanying materials are made available under the terms of the Eclipse 
Public License v2.0 which accompanies this distribution, and is available at 
https://www.eclipse.org/legal/epl-2.0/<br/><br/>

Contributors: Actuate Corporation - initial API and implementation
<p></p>

</p>
</BODY>
</HTML>
